/*
 * Copyright (c) 2001-2007, Inversoft, All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */
package org.inversoft.vertigo.security;

import org.inversoft.vertigo.acegi.ACEGIPasswordEncryptor;

import com.google.inject.ImplementedBy;

/**
 * <p>
 * This interface is a simple password encryptor.
 * </p>
 *
 * @author  Brian Pontarelli
 */
@ImplementedBy(ACEGIPasswordEncryptor.class)
public interface PasswordEncryptor {
    /**
     * Encrypts a password.
     *
     * @param   password The password to encrypt.
     * @param   obj This object is sometimes used to assist in the salt source to make the encryption
     *          better. However, implementations might not use this or a salt source at all.
     * @return  The encrypted password.
     */
    String encryptPassword(String password, Object obj);
}